Package com.google.cloud.compute.v1

Interface BackendOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Backend, Backend.Builder
    public interface BackendOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBalancingMode()
      Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded.
      com.google.protobuf.ByteString getBalancingModeBytes()
      Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded.
      float getCapacityScaler()
      A multiplier applied to the backend's target capacity of its balancing mode.
      String getDescription()
      An optional description of this resource.
      com.google.protobuf.ByteString getDescriptionBytes()
      An optional description of this resource.
      boolean getFailover()
      This field designates whether this is a failover backend.
      String getGroup()
      The fully-qualified URL of an instance group or network endpoint group (NEG) resource.
      com.google.protobuf.ByteString getGroupBytes()
      The fully-qualified URL of an instance group or network endpoint group (NEG) resource.
      int getMaxConnections()
      Defines a target maximum number of simultaneous connections.
      int getMaxConnectionsPerEndpoint()
      Defines a target maximum number of simultaneous connections.
      int getMaxConnectionsPerInstance()
      Defines a target maximum number of simultaneous connections.
      int getMaxRate()
      Defines a maximum number of HTTP requests per second (RPS).
      float getMaxRatePerEndpoint()
      Defines a maximum target for requests per second (RPS).
      float getMaxRatePerInstance()
      Defines a maximum target for requests per second (RPS).
      float getMaxUtilization()
      Optional parameter to define a target capacity for the UTILIZATION balancing mode.
      boolean hasBalancingMode()
      Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded.
      boolean hasCapacityScaler()
      A multiplier applied to the backend's target capacity of its balancing mode.
      boolean hasDescription()
      An optional description of this resource.
      boolean hasFailover()
      This field designates whether this is a failover backend.
      boolean hasGroup()
      The fully-qualified URL of an instance group or network endpoint group (NEG) resource.
      boolean hasMaxConnections()
      Defines a target maximum number of simultaneous connections.
      boolean hasMaxConnectionsPerEndpoint()
      Defines a target maximum number of simultaneous connections.
      boolean hasMaxConnectionsPerInstance()
      Defines a target maximum number of simultaneous connections.
      boolean hasMaxRate()
      Defines a maximum number of HTTP requests per second (RPS).
      boolean hasMaxRatePerEndpoint()
      Defines a maximum target for requests per second (RPS).
      boolean hasMaxRatePerInstance()
      Defines a maximum target for requests per second (RPS).
      boolean hasMaxUtilization()
      Optional parameter to define a target capacity for the UTILIZATION balancing mode.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasBalancingMode

        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:
        Whether the balancingMode field is set.

      • getBalancingMode

        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:
        The balancingMode.

      • getBalancingModeBytes

        com.google.protobuf.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:
        The bytes for balancingMode.

      • hasCapacityScaler

        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:
        Whether the capacityScaler field is set.

      • getCapacityScaler

        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:
        The capacityScaler.

      • hasDescription

        boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        Whether the description field is set.

      • getDescription

        String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        The bytes for description.

      • hasFailover

        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:
        Whether the failover field is set.

      • getFailover

        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:
        The failover.

      • hasGroup

        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](https://cloud.google.com/load-balancing/docs/backend-service#backends). 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:
        Whether the group field is set.

      • getGroup

        String 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](https://cloud.google.com/load-balancing/docs/backend-service#backends). 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:
        The group.

      • getGroupBytes

        com.google.protobuf.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](https://cloud.google.com/load-balancing/docs/backend-service#backends). 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:
        The bytes for group.

      • hasMaxConnections

        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:
        Whether the maxConnections field is set.

      • getMaxConnections

        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:
        The maxConnections.

      • hasMaxConnectionsPerEndpoint

        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:
        Whether the maxConnectionsPerEndpoint field is set.

      • getMaxConnectionsPerEndpoint

        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:
        The maxConnectionsPerEndpoint.

      • hasMaxConnectionsPerInstance

        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:
        Whether the maxConnectionsPerInstance field is set.

      • getMaxConnectionsPerInstance

        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:
        The maxConnectionsPerInstance.

      • hasMaxRate

        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:
        Whether the maxRate field is set.

      • getMaxRate

        int 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:
        The maxRate.

      • hasMaxRatePerEndpoint

        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:
        Whether the maxRatePerEndpoint field is set.

      • getMaxRatePerEndpoint

        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:
        The maxRatePerEndpoint.

      • hasMaxRatePerInstance

        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:
        Whether the maxRatePerInstance field is set.

      • getMaxRatePerInstance

        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:
        The maxRatePerInstance.

      • hasMaxUtilization

        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:
        Whether the maxUtilization field is set.

      • getMaxUtilization

        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:
        The maxUtilization.