com.google.api.services.compute.model

Class Backend

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: http://code.google.com/p/google-http-java-client/wiki/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()

Method Summary

Methods

Modifier and Type	Method and Description
Backend	clone()
java.lang.String	getBalancingMode() The balancing mode of this backend, default is UTILIZATION.
java.lang.Float	getCapacityScaler() The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to.
java.lang.String	getDescription() An optional textual description of the resource, which is provided by the client when the resource is created.
java.lang.String	getGroup() URL of a zonal Cloud Resource View resource.
java.lang.Integer	getMaxRate() The max RPS of the group.
java.lang.Float	getMaxRatePerInstance() The max RPS that a single backed instance can handle.
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) The balancing mode of this backend, default is UTILIZATION.
Backend	setCapacityScaler(java.lang.Float capacityScaler) The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to.
Backend	setDescription(java.lang.String description) An optional textual description of the resource, which is provided by the client when the resource is created.
Backend	setGroup(java.lang.String group) URL of a zonal Cloud Resource View resource.
Backend	setMaxRate(java.lang.Integer maxRate) The max RPS of the group.
Backend	setMaxRatePerInstance(java.lang.Float maxRatePerInstance) The max RPS that a single backed instance can handle.
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()

The balancing mode of this backend, default is UTILIZATION.

Returns:

value or null for none

setBalancingMode

public Backend setBalancingMode(java.lang.String balancingMode)

The balancing mode of this backend, default is UTILIZATION.

Parameters:

balancingMode - balancingMode or null for none

getCapacityScaler

public java.lang.Float getCapacityScaler()

The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].

Returns:

value or null for none

setCapacityScaler

public Backend setCapacityScaler(java.lang.Float capacityScaler)

The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].

Parameters:

capacityScaler - capacityScaler or null for none

getDescription

public java.lang.String getDescription()

An optional textual description of the resource, which is provided by the client when the resource is created.

Returns:

value or null for none

setDescription

public Backend setDescription(java.lang.String description)

An optional textual description of the resource, which is provided by the client when the resource is created.

Parameters:

description - description or null for none

getGroup

public java.lang.String getGroup()

URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource.

Returns:

value or null for none

setGroup

public Backend setGroup(java.lang.String group)

URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource.

Parameters:

group - group or null for none

getMaxRate

public java.lang.Integer getMaxRate()

The max RPS of the group. Can be used with either balancing mode, 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 RPS of the group. Can be used with either balancing mode, 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 RPS that a single backed 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 RPS that a single backed 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, 1].

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, 1].

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