com.google.cloud.compute.v1

Class Backend

java.lang.Object

com.google.cloud.compute.v1.Backend

All Implemented Interfaces:

ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class Backend
extends Object
implements ApiMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Backend.Builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ApiMessage	getApiMessageRequestBody()
String	getBalancingMode() Specifies the balancing mode for this backend.
Float	getCapacityScaler() A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).
static Backend	getDefaultInstance()
String	getDescription() An optional description of this resource.
List<String>	getFieldMask()
Object	getFieldValue(String fieldName)
String	getGroup() The fully-qualified URL of an Instance Group or Network Endpoint Group resource.
Integer	getMaxConnections() The max number of simultaneous connections for the group.
Integer	getMaxConnectionsPerEndpoint() The max number of simultaneous connections that a single backend network endpoint can handle.
Integer	getMaxConnectionsPerInstance() The max number of simultaneous connections that a single backend instance can handle.
Integer	getMaxRate() The max requests per second (RPS) of the group.
Float	getMaxRatePerEndpoint() The max requests per second (RPS) that a single backend network endpoint can handle.
Float	getMaxRatePerInstance() The max requests per second (RPS) that a single backend instance can handle.
Float	getMaxUtilization() Used when balancingMode is UTILIZATION.
int	hashCode()
static Backend.Builder	newBuilder()
static Backend.Builder	newBuilder(Backend prototype)
Backend.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFieldValue

public Object getFieldValue(String fieldName)

Specified by:

getFieldValue in interface ApiMessage

getApiMessageRequestBody

@Nullable
public ApiMessage getApiMessageRequestBody()

Specified by:

getApiMessageRequestBody in interface ApiMessage

getFieldMask

@Nullable
public List<String> getFieldMask()

Specified by:

getFieldMask in interface ApiMessage

getBalancingMode

public String getBalancingMode()

Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).

For Internal Load Balancing, the default and only supported mode is CONNECTION.

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

This cannot be used for internal load balancing.

getDescription

public String getDescription()

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

getGroup

public String getGroup()

The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this 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.

For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.

Backend service can not contain mix of Instance Group and Network Endpoint Group backends.

Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.

When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Network Endpoint Groups are not supported for INTERNAL load balancing scheme.

getMaxConnections

public Integer getMaxConnections()

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

getMaxConnectionsPerEndpoint

public Integer getMaxConnectionsPerEndpoint()

The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.

This cannot be used for internal load balancing.

getMaxConnectionsPerInstance

public Integer getMaxConnectionsPerInstance()

The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

getMaxRate

public 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.

This cannot be used for internal load balancing.

getMaxRatePerEndpoint

public Float getMaxRatePerEndpoint()

The max requests per second (RPS) that a single backend network endpoint 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 maxRatePerEndpoint must be set.

This cannot be used for internal load balancing.

getMaxRatePerInstance

public 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.

This cannot be used for internal load balancing.

getMaxUtilization

public 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].

This cannot be used for internal load balancing.

newBuilder

public static Backend.Builder newBuilder()

newBuilder

public static Backend.Builder newBuilder(Backend prototype)

toBuilder

public Backend.Builder toBuilder()

getDefaultInstance

public static Backend getDefaultInstance()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object