• Home
• com.google.api.grpc
• proto-google-cloud-compute-v1
• 1.65.0
• source code
• BackendOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.compute.v1.BackendOrBuilder Maven / Gradle / Ivy

/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/compute/v1/compute.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.compute.v1;

public interface BackendOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.Backend)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the balancingMode field is set.
   */
  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;
   *
   * @return The balancingMode.
   */
  java.lang.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;
   *
   * @return The bytes for balancingMode.
   */
  com.google.protobuf.ByteString getBalancingModeBytes();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the capacityScaler field is set.
   */
  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;
   *
   * @return The capacityScaler.
   */
  float getCapacityScaler();

  /**
   *
   *
   * 
   * An optional description of this resource. Provide this property when you create the resource.
   * 
   *
   * optional string description = 422937596;
   *
   * @return Whether the description field is set.
   */
  boolean hasDescription();
  /**
   *
   *
   * 
   * An optional description of this resource. Provide this property when you create the resource.
   * 
   *
   * optional string description = 422937596;
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   * 
   * An optional description of this resource. Provide this property when you create the resource.
   * 
   *
   * optional string description = 422937596;
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the failover field is set.
   */
  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;
   *
   * @return The failover.
   */
  boolean getFailover();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the group field is set.
   */
  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;
   *
   * @return The group.
   */
  java.lang.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;
   *
   * @return The bytes for group.
   */
  com.google.protobuf.ByteString getGroupBytes();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the maxConnections field is set.
   */
  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;
   *
   * @return The maxConnections.
   */
  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_per_endpoint = 216904604;
   *
   * @return Whether the maxConnectionsPerEndpoint field is set.
   */
  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;
   *
   * @return The maxConnectionsPerEndpoint.
   */
  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_instance = 104671900;
   *
   * @return Whether the maxConnectionsPerInstance field is set.
   */
  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;
   *
   * @return The maxConnectionsPerInstance.
   */
  int getMaxConnectionsPerInstance();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the maxRate field is set.
   */
  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;
   *
   * @return The maxRate.
   */
  int getMaxRate();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the maxRatePerEndpoint field is set.
   */
  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;
   *
   * @return The maxRatePerEndpoint.
   */
  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_instance = 17599579;
   *
   * @return Whether the maxRatePerInstance field is set.
   */
  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;
   *
   * @return The maxRatePerInstance.
   */
  float getMaxRatePerInstance();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the maxUtilization field is set.
   */
  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;
   *
   * @return The maxUtilization.
   */
  float getMaxUtilization();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the preference field is set.
   */
  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;
   *
   * @return The preference.
   */
  java.lang.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;
   *
   * @return The bytes for preference.
   */
  com.google.protobuf.ByteString getPreferenceBytes();
}