Backend (Compute Engine API v1 (Rev. 103) 1.21.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.Backend

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Backend
extends com.google.api.client.json.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Backend()

Constructors
Constructor and Description
`Backend()`

Method Summary

Methods
Modifier and Type	Method and Description
`Backend`	`clone()`
`java.lang.String`	`getBalancingMode()` Specifies the balancing mode for this backend.
`java.lang.Float`	`getCapacityScaler()` A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE).
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.lang.String`	`getGroup()` The fully-qualified URL of a zonal Instance Group resource.
`java.lang.Integer`	`getMaxRate()` The max requests per second (RPS) of the group.
`java.lang.Float`	`getMaxRatePerInstance()` The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group.
`java.lang.Float`	`getMaxUtilization()` Used when balancingMode is UTILIZATION.
`Backend`	`set(java.lang.String fieldName, java.lang.Object value)`
`Backend`	`setBalancingMode(java.lang.String balancingMode)` Specifies the balancing mode for this backend.
`Backend`	`setCapacityScaler(java.lang.Float capacityScaler)` A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE).
`Backend`	`setDescription(java.lang.String description)` An optional description of this resource.
`Backend`	`setGroup(java.lang.String group)` The fully-qualified URL of a zonal Instance Group resource.
`Backend`	`setMaxRate(java.lang.Integer maxRate)` The max requests per second (RPS) of the group.
`Backend`	`setMaxRatePerInstance(java.lang.Float maxRatePerInstance)` The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group.
`Backend`	`setMaxUtilization(java.lang.Float maxUtilization)` Used when balancingMode is UTILIZATION.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Backend
```
public Backend()
```
- Method Detail
  - getBalancingMode
```
public java.lang.String getBalancingMode()
```
    Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
    
    Returns:
    value or null for none
  - setBalancingMode
```
public Backend setBalancingMode(java.lang.String balancingMode)
```
    Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
    
    Parameters:
    balancingMode - balancingMode or null for none
  - getCapacityScaler
```
public java.lang.Float getCapacityScaler()
```
    A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
    
    Returns:
    value or null for none
  - setCapacityScaler
```
public Backend setCapacityScaler(java.lang.Float capacityScaler)
```
    A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
    
    Parameters:
    capacityScaler - capacityScaler or null for none
  - getDescription
```
public java.lang.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(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    description - description or null for none
  - getGroup
```
public java.lang.String getGroup()
```
    The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
    
    Returns:
    value or null for none
  - setGroup
```
public Backend setGroup(java.lang.String group)
```
    The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
    
    Parameters:
    group - group or null for none
  - getMaxRate
```
public java.lang.Integer getMaxRate()
```
    The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
    
    Returns:
    value or null for none
  - setMaxRate
```
public Backend setMaxRate(java.lang.Integer maxRate)
```
    The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
    
    Parameters:
    maxRate - maxRate or null for none
  - getMaxRatePerInstance
```
public java.lang.Float getMaxRatePerInstance()
```
    The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
    
    Returns:
    value or null for none
  - setMaxRatePerInstance
```
public Backend setMaxRatePerInstance(java.lang.Float maxRatePerInstance)
```
    The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
    
    Parameters:
    maxRatePerInstance - maxRatePerInstance or null for none
  - getMaxUtilization
```
public java.lang.Float getMaxUtilization()
```
    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
    
    Returns:
    value or null for none
  - setMaxUtilization
```
public Backend setMaxUtilization(java.lang.Float maxUtilization)
```
    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
    
    Parameters:
    maxUtilization - maxUtilization or null for none
  - set
```
public Backend set(java.lang.String fieldName,
          java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Backend clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 103)

Class Backend

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

Backend

Method Detail

getBalancingMode

setBalancingMode

getCapacityScaler

setCapacityScaler

getDescription

setDescription

getGroup

setGroup

getMaxRate

setMaxRate

getMaxRatePerInstance

setMaxRatePerInstance

getMaxUtilization

setMaxUtilization

set

clone