public final class Backend extends GeneratedMessageV3 implements BackendOrBuilder
Message containing information of one individual backend.
Protobuf type google.cloud.compute.v1.Backend
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BALANCING_MODE_FIELD_NUMBER
public static final int BALANCING_MODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CAPACITY_SCALER_FIELD_NUMBER
public static final int CAPACITY_SCALER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FAILOVER_FIELD_NUMBER
public static final int FAILOVER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GROUP_FIELD_NUMBER
public static final int GROUP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_CONNECTIONS_FIELD_NUMBER
public static final int MAX_CONNECTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_CONNECTIONS_PER_ENDPOINT_FIELD_NUMBER
public static final int MAX_CONNECTIONS_PER_ENDPOINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_CONNECTIONS_PER_INSTANCE_FIELD_NUMBER
public static final int MAX_CONNECTIONS_PER_INSTANCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_RATE_FIELD_NUMBER
public static final int MAX_RATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_RATE_PER_ENDPOINT_FIELD_NUMBER
public static final int MAX_RATE_PER_ENDPOINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_RATE_PER_INSTANCE_FIELD_NUMBER
public static final int MAX_RATE_PER_INSTANCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_UTILIZATION_FIELD_NUMBER
public static final int MAX_UTILIZATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PREFERENCE_FIELD_NUMBER
public static final int PREFERENCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Backend getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Backend.Builder newBuilder()
newBuilder(Backend prototype)
public static Backend.Builder newBuilder(Backend prototype)
| Parameter |
| Name |
Description |
prototype |
Backend
|
public static Backend parseDelimitedFrom(InputStream input)
public static Backend parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Backend parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Backend parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Backend parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Backend parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Backend parseFrom(CodedInputStream input)
public static Backend parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Backend parseFrom(InputStream input)
public static Backend parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Backend parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Backend parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Backend> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBalancingMode()
public String getBalancingMode()
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.
optional string balancing_mode = 430286217;
| Returns |
| Type |
Description |
String |
The balancingMode.
|
getBalancingModeBytes()
public ByteString getBalancingModeBytes()
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.
optional string balancing_mode = 430286217;
| Returns |
| Type |
Description |
ByteString |
The bytes for balancingMode.
|
getCapacityScaler()
public float getCapacityScaler()
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.
optional float capacity_scaler = 315958157;
| Returns |
| Type |
Description |
float |
The capacityScaler.
|
getDefaultInstanceForType()
public Backend getDefaultInstanceForType()
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
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.
optional bool failover = 138892530;
| Returns |
| Type |
Description |
boolean |
The failover.
|
getGroup()
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.
optional string group = 98629247;
| Returns |
| Type |
Description |
String |
The group.
|
getGroupBytes()
public ByteString getGroupBytes()
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.
optional string group = 98629247;
| Returns |
| Type |
Description |
ByteString |
The bytes for group.
|
getMaxConnections()
public int getMaxConnections()
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.
optional int32 max_connections = 110652154;
| Returns |
| Type |
Description |
int |
The maxConnections.
|
getMaxConnectionsPerEndpoint()
public int getMaxConnectionsPerEndpoint()
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.
optional int32 max_connections_per_endpoint = 216904604;
| Returns |
| Type |
Description |
int |
The maxConnectionsPerEndpoint.
|
getMaxConnectionsPerInstance()
public int getMaxConnectionsPerInstance()
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.
optional int32 max_connections_per_instance = 104671900;
| Returns |
| Type |
Description |
int |
The maxConnectionsPerInstance.
|
getMaxRate()
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.
optional int32 max_rate = 408035035;
| Returns |
| Type |
Description |
int |
The maxRate.
|
getMaxRatePerEndpoint()
public float getMaxRatePerEndpoint()
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.
optional float max_rate_per_endpoint = 129832283;
| Returns |
| Type |
Description |
float |
The maxRatePerEndpoint.
|
getMaxRatePerInstance()
public float getMaxRatePerInstance()
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.
optional float max_rate_per_instance = 17599579;
| Returns |
| Type |
Description |
float |
The maxRatePerInstance.
|
getMaxUtilization()
public float getMaxUtilization()
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.
optional float max_utilization = 148192199;
| Returns |
| Type |
Description |
float |
The maxUtilization.
|
getParserForType()
public Parser<Backend> getParserForType()
Overrides
getPreference()
public String getPreference()
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.
optional string preference = 150781147;
| Returns |
| Type |
Description |
String |
The preference.
|
getPreferenceBytes()
public ByteString getPreferenceBytes()
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.
optional string preference = 150781147;
| Returns |
| Type |
Description |
ByteString |
The bytes for preference.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasBalancingMode()
public boolean hasBalancingMode()
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.
optional string balancing_mode = 430286217;
| Returns |
| Type |
Description |
boolean |
Whether the balancingMode field is set.
|
hasCapacityScaler()
public boolean hasCapacityScaler()
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.
optional float capacity_scaler = 315958157;
| Returns |
| Type |
Description |
boolean |
Whether the capacityScaler field is set.
|
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
| Type |
Description |
boolean |
Whether the description field is set.
|
hasFailover()
public boolean hasFailover()
This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
optional bool failover = 138892530;
| Returns |
| Type |
Description |
boolean |
Whether the failover field is set.
|
hasGroup()
public boolean hasGroup()
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.
optional string group = 98629247;
| Returns |
| Type |
Description |
boolean |
Whether the group field is set.
|
hasMaxConnections()
public boolean hasMaxConnections()
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.
optional int32 max_connections = 110652154;
| Returns |
| Type |
Description |
boolean |
Whether the maxConnections field is set.
|
hasMaxConnectionsPerEndpoint()
public boolean hasMaxConnectionsPerEndpoint()
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.
optional int32 max_connections_per_endpoint = 216904604;
| Returns |
| Type |
Description |
boolean |
Whether the maxConnectionsPerEndpoint field is set.
|
hasMaxConnectionsPerInstance()
public boolean hasMaxConnectionsPerInstance()
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.
optional int32 max_connections_per_instance = 104671900;
| Returns |
| Type |
Description |
boolean |
Whether the maxConnectionsPerInstance field is set.
|
hasMaxRate()
public boolean hasMaxRate()
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.
optional int32 max_rate = 408035035;
| Returns |
| Type |
Description |
boolean |
Whether the maxRate field is set.
|
hasMaxRatePerEndpoint()
public boolean hasMaxRatePerEndpoint()
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.
optional float max_rate_per_endpoint = 129832283;
| Returns |
| Type |
Description |
boolean |
Whether the maxRatePerEndpoint field is set.
|
hasMaxRatePerInstance()
public boolean hasMaxRatePerInstance()
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.
optional float max_rate_per_instance = 17599579;
| Returns |
| Type |
Description |
boolean |
Whether the maxRatePerInstance field is set.
|
hasMaxUtilization()
public boolean hasMaxUtilization()
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.
optional float max_utilization = 148192199;
| Returns |
| Type |
Description |
boolean |
Whether the maxUtilization field is set.
|
hasPreference()
public boolean hasPreference()
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.
optional string preference = 150781147;
| Returns |
| Type |
Description |
boolean |
Whether the preference field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Backend.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Backend.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Backend.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
