Package com.google.cloud.compute.v1

Interface AutoscalingPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AutoscalingPolicy, AutoscalingPolicy.Builder
@Generated public interface AutoscalingPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasCoolDownPeriodSec

      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;
      Returns:
      Whether the coolDownPeriodSec field is set.

    • getCoolDownPeriodSec

      int getCoolDownPeriodSec()
       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;
      Returns:
      The coolDownPeriodSec.

    • hasCpuUtilization

      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;
      Returns:
      Whether the cpuUtilization field is set.

    • getCpuUtilization

      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;
      Returns:
      The cpuUtilization.

    • getCpuUtilizationOrBuilder

      AutoscalingPolicyCpuUtilizationOrBuilder getCpuUtilizationOrBuilder()
       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;

    • getCustomMetricUtilizationsList

      List<AutoscalingPolicyCustomMetricUtilization> getCustomMetricUtilizationsList()
       Configuration parameters of autoscaling based on a custom metric.
      repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

    • getCustomMetricUtilizations

      AutoscalingPolicyCustomMetricUtilization getCustomMetricUtilizations(int index)
       Configuration parameters of autoscaling based on a custom metric.
      repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

    • getCustomMetricUtilizationsCount

      int getCustomMetricUtilizationsCount()
       Configuration parameters of autoscaling based on a custom metric.
      repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

    • getCustomMetricUtilizationsOrBuilderList

      List<? extends AutoscalingPolicyCustomMetricUtilizationOrBuilder> getCustomMetricUtilizationsOrBuilderList()
       Configuration parameters of autoscaling based on a custom metric.
      repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

    • getCustomMetricUtilizationsOrBuilder

      AutoscalingPolicyCustomMetricUtilizationOrBuilder getCustomMetricUtilizationsOrBuilder(int index)
       Configuration parameters of autoscaling based on a custom metric.
      repeated .google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization custom_metric_utilizations = 131972850;

    • hasLoadBalancingUtilization

      boolean hasLoadBalancingUtilization()
       Configuration parameters of autoscaling based on load balancer.
      optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;
      Returns:
      Whether the loadBalancingUtilization field is set.

    • getLoadBalancingUtilization

      AutoscalingPolicyLoadBalancingUtilization getLoadBalancingUtilization()
       Configuration parameters of autoscaling based on load balancer.
      optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;
      Returns:
      The loadBalancingUtilization.

    • getLoadBalancingUtilizationOrBuilder

      AutoscalingPolicyLoadBalancingUtilizationOrBuilder getLoadBalancingUtilizationOrBuilder()
       Configuration parameters of autoscaling based on load balancer.
      optional .google.cloud.compute.v1.AutoscalingPolicyLoadBalancingUtilization load_balancing_utilization = 429746403;

    • hasMaxNumReplicas

      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;
      Returns:
      Whether the maxNumReplicas field is set.

    • getMaxNumReplicas

      int getMaxNumReplicas()
       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;
      Returns:
      The maxNumReplicas.

    • hasMinNumReplicas

      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;
      Returns:
      Whether the minNumReplicas field is set.

    • getMinNumReplicas

      int getMinNumReplicas()
       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;
      Returns:
      The minNumReplicas.

    • hasMode

      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;
      Returns:
      Whether the mode field is set.

    • getMode

      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;
      Returns:
      The mode.

    • getModeBytes

      com.google.protobuf.ByteString getModeBytes()
       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;
      Returns:
      The bytes for mode.

    • hasScaleInControl

      boolean hasScaleInControl()
      optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
      Returns:
      Whether the scaleInControl field is set.

    • getScaleInControl

      AutoscalingPolicyScaleInControl getScaleInControl()
      optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;
      Returns:
      The scaleInControl.

    • getScaleInControlOrBuilder

      AutoscalingPolicyScaleInControlOrBuilder getScaleInControlOrBuilder()
      optional .google.cloud.compute.v1.AutoscalingPolicyScaleInControl scale_in_control = 527670872;

    • getScalingSchedulesCount

      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;

    • containsScalingSchedules

      boolean containsScalingSchedules(String key)
       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;

    • getScalingSchedules

      @Deprecated Map<String,AutoscalingPolicyScalingSchedule> getScalingSchedules()
      Deprecated.
      Use getScalingSchedulesMap() instead.

    • getScalingSchedulesMap

      Map<String,AutoscalingPolicyScalingSchedule> 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;

    • getScalingSchedulesOrDefault

      AutoscalingPolicyScalingSchedule getScalingSchedulesOrDefault(String key, 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;

    • getScalingSchedulesOrThrow

      AutoscalingPolicyScalingSchedule getScalingSchedulesOrThrow(String key)
       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;