Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Backend (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Backend.

Message containing information of one individual backend.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#balancing_mode

def balancing_mode() -> ::String
Returns
  • (::String) — 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.

#balancing_mode=

def balancing_mode=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#capacity_scaler

def capacity_scaler() -> ::Float
Returns
  • (::Float) — 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 onbalancingMode). 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 than0.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 abalancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.

#capacity_scaler=

def capacity_scaler=(value) -> ::Float
Parameter
  • value (::Float) — 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 onbalancingMode). 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 than0.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 abalancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.

Returns
  • (::Float) — 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 onbalancingMode). 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 than0.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 abalancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.

#custom_metrics

def custom_metrics() -> ::Array<::Google::Cloud::Compute::V1::BackendCustomMetric>
Returns

#custom_metrics=

def custom_metrics=(value) -> ::Array<::Google::Cloud::Compute::V1::BackendCustomMetric>
Parameter
Returns

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#failover

def failover() -> ::Boolean
Returns
  • (::Boolean) — This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

#failover=

def failover=(value) -> ::Boolean
Parameter
  • value (::Boolean) — This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
Returns
  • (::Boolean) — This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

#group

def group() -> ::String
Returns
  • (::String) — The fully-qualified URL of aninstance 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 withhttps://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

    If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP.

#group=

def group=(value) -> ::String
Parameter
  • value (::String) — The fully-qualified URL of aninstance 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 withhttps://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

    If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP.

Returns
  • (::String) — The fully-qualified URL of aninstance 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 withhttps://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

    If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP.

#max_connections

def max_connections() -> ::Integer
Returns
  • (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode. Not available if the backend'sbalancingMode is RATE.

#max_connections=

def max_connections=(value) -> ::Integer
Parameter
  • value (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode. Not available if the backend'sbalancingMode is RATE.
Returns
  • (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode. Not available if the backend'sbalancingMode is RATE.

#max_connections_per_endpoint

def max_connections_per_endpoint() -> ::Integer
Returns
  • (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isRATE.

#max_connections_per_endpoint=

def max_connections_per_endpoint=(value) -> ::Integer
Parameter
  • value (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isRATE.

Returns
  • (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isRATE.

#max_connections_per_instance

def max_connections_per_instance() -> ::Integer
Returns
  • (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isRATE.

#max_connections_per_instance=

def max_connections_per_instance=(value) -> ::Integer
Parameter
  • value (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isRATE.

Returns
  • (::Integer) — Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isRATE.

#max_rate

def max_rate() -> ::Integer
Returns
  • (::Integer) — Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

#max_rate=

def max_rate=(value) -> ::Integer
Parameter
  • value (::Integer) — Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

Returns
  • (::Integer) — Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

#max_rate_per_endpoint

def max_rate_per_endpoint() -> ::Float
Returns
  • (::Float) — Defines a maximum target for requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

#max_rate_per_endpoint=

def max_rate_per_endpoint=(value) -> ::Float
Parameter
  • value (::Float) — Defines a maximum target for requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

Returns
  • (::Float) — Defines a maximum target for requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

#max_rate_per_instance

def max_rate_per_instance() -> ::Float
Returns
  • (::Float) — Defines a maximum target for requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

#max_rate_per_instance=

def max_rate_per_instance=(value) -> ::Float
Parameter
  • value (::Float) — Defines a maximum target for requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

Returns
  • (::Float) — Defines a maximum target for requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode.

    Not available if the backend's balancingMode isCONNECTION.

#max_utilization

def max_utilization() -> ::Float
Returns
  • (::Float) — Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].

    For usage guidelines, seeUtilization balancing mode.

#max_utilization=

def max_utilization=(value) -> ::Float
Parameter
  • value (::Float) — Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].

    For usage guidelines, seeUtilization balancing mode.

Returns
  • (::Float) — Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].

    For usage guidelines, seeUtilization balancing mode.

#orchestration_info

def orchestration_info() -> ::Google::Cloud::Compute::V1::BackendBackendOrchestrationInfo
Returns

#orchestration_info=

def orchestration_info=(value) -> ::Google::Cloud::Compute::V1::BackendBackendOrchestrationInfo
Parameter
Returns

#preference

def preference() -> ::String
Returns
  • (::String) —

    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.

#preference=

def preference=(value) -> ::String
Parameter
  • value (::String) —

    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.
Returns
  • (::String) —

    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.