com.google.api.services.compute.model

Class Backend

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.Backend

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Backend
extends GenericJson

Message containing information of one individual backend.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Backend()

Method Summary

Modifier and Type	Method and Description
Backend	clone()
String	getBalancingMode() Specifies the balancing mode for the backend.
Float	getCapacityScaler() A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
String	getDescription() An optional description of this resource.
Boolean	getFailover() This field designates whether this is a failover backend.
String	getGroup() The fully-qualified URL of an instance group or network endpoint group (NEG) resource.
Integer	getMaxConnections() Defines a target maximum number of simultaneous connections that the backend can handle.
Integer	getMaxConnectionsPerEndpoint() Defines a target maximum number of simultaneous connections for an endpoint of a NEG.
Integer	getMaxConnectionsPerInstance() Defines a target maximum number of simultaneous connections for a single VM in a backend instance group.
Integer	getMaxRate() Defines a maximum number of HTTP requests per second (RPS) that the backend can handle.
Float	getMaxRatePerEndpoint() Defines a maximum target for requests per second (RPS) for an endpoint of a NEG.
Float	getMaxRatePerInstance() Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group.
Float	getMaxUtilization() Defines the maximum average backend utilization of a backend VM in an instance group.
Backend	set(String fieldName, Object value)
Backend	setBalancingMode(String balancingMode) Specifies the balancing mode for the backend.
Backend	setCapacityScaler(Float capacityScaler) A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
Backend	setDescription(String description) An optional description of this resource.
Backend	setFailover(Boolean failover) This field designates whether this is a failover backend.
Backend	setGroup(String group) The fully-qualified URL of an instance group or network endpoint group (NEG) resource.
Backend	setMaxConnections(Integer maxConnections) Defines a target maximum number of simultaneous connections that the backend can handle.
Backend	setMaxConnectionsPerEndpoint(Integer maxConnectionsPerEndpoint) Defines a target maximum number of simultaneous connections for an endpoint of a NEG.
Backend	setMaxConnectionsPerInstance(Integer maxConnectionsPerInstance) Defines a target maximum number of simultaneous connections for a single VM in a backend instance group.
Backend	setMaxRate(Integer maxRate) Defines a maximum number of HTTP requests per second (RPS) that the backend can handle.
Backend	setMaxRatePerEndpoint(Float maxRatePerEndpoint) Defines a maximum target for requests per second (RPS) for an endpoint of a NEG.
Backend	setMaxRatePerInstance(Float maxRatePerInstance) Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group.
Backend	setMaxUtilization(Float maxUtilization) Defines the maximum average backend utilization of a backend VM in an instance group.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Backend

public Backend()

Method Detail

getBalancingMode

public String getBalancingMode()

Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint. - If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.

Returns:

value or null for none

setBalancingMode

public Backend setBalancingMode(String balancingMode)

Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. You can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. - If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS). You can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint. - If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group. You can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.

Parameters:

balancingMode - balancingMode or null for none

getCapacityScaler

public Float getCapacityScaler()

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve 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. Valid range is 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. This cannot be used for internal load balancing.

Returns:

value or null for none

setCapacityScaler

public Backend setCapacityScaler(Float capacityScaler)

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve 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. Valid range is 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. This cannot be used for internal load balancing.

Parameters:

capacityScaler - capacityScaler or null for none

getDescription

public String getDescription()

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

Returns:

value or null for none

setDescription

public Backend setDescription(String description)

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

Parameters:

description - description or null for none

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.

Returns:

value or null for none

setFailover

public Backend setFailover(Boolean failover)

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

Parameters:

failover - failover or null for none

getGroup

public String getGroup()

The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme. - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. 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.

Returns:

value or null for none

setGroup

public Backend setGroup(String group)

The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme. - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. 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.

Parameters:

group - group or null for none

getMaxConnections

public Integer getMaxConnections()

Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.

Returns:

value or null for none

setMaxConnections

public Backend setMaxConnections(Integer maxConnections)

Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.

Parameters:

maxConnections - maxConnections or null for none

getMaxConnectionsPerEndpoint

public Integer getMaxConnectionsPerEndpoint()

Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.

Returns:

value or null for none

setMaxConnectionsPerEndpoint

public Backend setMaxConnectionsPerEndpoint(Integer maxConnectionsPerEndpoint)

Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.

Parameters:

maxConnectionsPerEndpoint - maxConnectionsPerEndpoint or null for none

getMaxConnectionsPerInstance

public Integer getMaxConnectionsPerInstance()

Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.

Returns:

value or null for none

setMaxConnectionsPerInstance

public Backend setMaxConnectionsPerInstance(Integer maxConnectionsPerInstance)

Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.

Parameters:

maxConnectionsPerInstance - maxConnectionsPerInstance or null for none

getMaxRate

public Integer getMaxRate()

Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION.

Returns:

value or null for none

setMaxRate

public Backend setMaxRate(Integer maxRate)

Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION.

Parameters:

maxRate - maxRate or null for none

getMaxRatePerEndpoint

public Float getMaxRatePerEndpoint()

Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION.

Returns:

value or null for none

setMaxRatePerEndpoint

public Backend setMaxRatePerEndpoint(Float maxRatePerEndpoint)

Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION.

Parameters:

maxRatePerEndpoint - maxRatePerEndpoint or null for none

getMaxRatePerInstance

public Float getMaxRatePerInstance()

Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION.

Returns:

value or null for none

setMaxRatePerInstance

public Backend setMaxRatePerInstance(Float maxRatePerInstance)

Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION.

Parameters:

maxRatePerInstance - maxRatePerInstance or null for none

getMaxUtilization

public Float getMaxUtilization()

Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.

Returns:

value or null for none

setMaxUtilization

public Backend setMaxUtilization(Float maxUtilization)

Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.

Parameters:

maxUtilization - maxUtilization or null for none

set

public Backend set(String fieldName,
                   Object value)

Overrides:

set in class GenericJson

clone

public Backend clone()

Overrides:

clone in class GenericJson