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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-compute-v1 Show documentation
Proto library for google-cloud-compute
The newest version!
/*
 * 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 AutoscalingPolicyOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.AutoscalingPolicy)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The number of seconds that your application takes to initialize on a VM instance. This is referred to as the [initialization period](/compute/docs/autoscaler#cool_down_period). Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process.
   * 
   *
   * optional int32 cool_down_period_sec = 107692954;
   *
   * @return Whether the coolDownPeriodSec field is set.
   */
  boolean hasCoolDownPeriodSec();
  /**
   *
   *
   *    * The number of seconds that your application takes to initialize on a VM instance. This is referred to as the [initialization period](/compute/docs/autoscaler#cool_down_period). Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process.
   * 
   *
   * optional int32 cool_down_period_sec = 107692954;
   *
   * @return The coolDownPeriodSec.
   */
  int getCoolDownPeriodSec();

  /**
   *
   *
   *    * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
   * 
   *
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyCpuUtilization cpu_utilization = 381211147;
   * 
   *
   * @return Whether the cpuUtilization field is set.
   */
  boolean hasCpuUtilization();
  /**
   *
   *
   *    * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
   * 
   *
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyCpuUtilization cpu_utilization = 381211147;
   * 
   *
   * @return The cpuUtilization.
   */
  com.google.cloud.compute.v1.AutoscalingPolicyCpuUtilization getCpuUtilization();
  /**
   *
   *
   *    * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
   * 
   *
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyCpuUtilization cpu_utilization = 381211147;
   * 
   */
  com.google.cloud.compute.v1.AutoscalingPolicyCpuUtilizationOrBuilder getCpuUtilizationOrBuilder();

  /**
   *
   *
   *    * Configuration parameters of autoscaling based on a custom metric.
   * 
   *
   * 
   * repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;
   * 
   */
  java.util.List
      getCustomMetricUtilizationsList();
  /**
   *
   *
   *    * Configuration parameters of autoscaling based on a custom metric.
   * 
   *
   * 
   * repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;
   * 
   */
  com.google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization getCustomMetricUtilizations(
      int index);
  /**
   *
   *
   *    * Configuration parameters of autoscaling based on a custom metric.
   * 
   *
   * 
   * repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;
   * 
   */
  int getCustomMetricUtilizationsCount();
  /**
   *
   *
   *    * Configuration parameters of autoscaling based on a custom metric.
   * 
   *
   * 
   * repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;
   * 
   */
  java.util.List<
          ? extends com.google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilizationOrBuilder>
      getCustomMetricUtilizationsOrBuilderList();
  /**
   *
   *
   *    * Configuration parameters of autoscaling based on a custom metric.
   * 
   *
   * 
   * repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;
   * 
   */
  com.google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilizationOrBuilder
      getCustomMetricUtilizationsOrBuilder(int index);

  /**
   *
   *
   *    * Configuration parameters of autoscaling based on load balancer.
   * 
   *
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;
   * 
   *
   * @return Whether the loadBalancingUtilization field is set.
   */
  boolean hasLoadBalancingUtilization();
  /**
   *
   *
   *    * Configuration parameters of autoscaling based on load balancer.
   * 
   *
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;
   * 
   *
   * @return The loadBalancingUtilization.
   */
  com.google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization
      getLoadBalancingUtilization();
  /**
   *
   *
   *    * Configuration parameters of autoscaling based on load balancer.
   * 
   *
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;
   * 
   */
  com.google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilizationOrBuilder
      getLoadBalancingUtilizationOrBuilder();

  /**
   *
   *
   *    * The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.
   * 
   *
   * optional int32 max_num_replicas = 62327375;
   *
   * @return Whether the maxNumReplicas field is set.
   */
  boolean hasMaxNumReplicas();
  /**
   *
   *
   *    * The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.
   * 
   *
   * optional int32 max_num_replicas = 62327375;
   *
   * @return The maxNumReplicas.
   */
  int getMaxNumReplicas();

  /**
   *
   *
   *    * The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.
   * 
   *
   * optional int32 min_num_replicas = 535329825;
   *
   * @return Whether the minNumReplicas field is set.
   */
  boolean hasMinNumReplicas();
  /**
   *
   *
   *    * The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.
   * 
   *
   * optional int32 min_num_replicas = 535329825;
   *
   * @return The minNumReplicas.
   */
  int getMinNumReplicas();

  /**
   *
   *
   *    * Defines the operating mode for this policy. The following modes are available: - OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler"
   * Check the Mode enum for the list of possible values.
   * 
   *
   * optional string mode = 3357091;
   *
   * @return Whether the mode field is set.
   */
  boolean hasMode();
  /**
   *
   *
   *    * Defines the operating mode for this policy. The following modes are available: - OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler"
   * Check the Mode enum for the list of possible values.
   * 
   *
   * optional string mode = 3357091;
   *
   * @return The mode.
   */
  java.lang.String getMode();
  /**
   *
   *
   *    * Defines the operating mode for this policy. The following modes are available: - OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see "Turning off or restricting an autoscaler"
   * Check the Mode enum for the list of possible values.
   * 
   *
   * optional string mode = 3357091;
   *
   * @return The bytes for mode.
   */
  com.google.protobuf.ByteString getModeBytes();

  /**
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
   * 
   *
   * @return Whether the scaleInControl field is set.
   */
  boolean hasScaleInControl();
  /**
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
   * 
   *
   * @return The scaleInControl.
   */
  com.google.cloud.compute.v1.AutoscalingPolicyScaleInControl getScaleInControl();
  /**
   * 
   * optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
   * 
   */
  com.google.cloud.compute.v1.AutoscalingPolicyScaleInControlOrBuilder getScaleInControlOrBuilder();

  /**
   *
   *
   *    * Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.
   * 
   *
   * 
   * map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;
   * 
   */
  int getScalingSchedulesCount();
  /**
   *
   *
   *    * Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.
   * 
   *
   * 
   * map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;
   * 
   */
  boolean containsScalingSchedules(java.lang.String key);
  /** Use {@link #getScalingSchedulesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map
      getScalingSchedules();
  /**
   *
   *
   *    * Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.
   * 
   *
   * 
   * map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;
   * 
   */
  java.util.Map
      getScalingSchedulesMap();
  /**
   *
   *
   *    * Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.
   * 
   *
   * 
   * map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;
   * 
   */
  /* nullable */
  com.google.cloud.compute.v1.AutoscalingPolicyScalingSchedule getScalingSchedulesOrDefault(
      java.lang.String key,
      /* nullable */
      com.google.cloud.compute.v1.AutoscalingPolicyScalingSchedule defaultValue);
  /**
   *
   *
   *    * Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.
   * 
   *
   * 
   * map<string, .google.cloud.compute.v1.AutoscalingPolicyScalingSchedule> scaling_schedules = 355416580;
   * 
   */
  com.google.cloud.compute.v1.AutoscalingPolicyScalingSchedule getScalingSchedulesOrThrow(
      java.lang.String key);
}