Package com.google.cloud.compute.v1

Interface AutoscalingPolicyCustomMetricUtilizationOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    A filter string, compatible with a Stackdriver Monitoringfilter string forTimeSeries.list API call.
    com.google.protobuf.ByteString
    getFilterBytes()
    A filter string, compatible with a Stackdriver Monitoringfilter string forTimeSeries.list API call.
    String
    getMetric()
    The identifier (type) of the Stackdriver Monitoring metric.
    com.google.protobuf.ByteString
    getMetricBytes()
    The identifier (type) of the Stackdriver Monitoring metric.
    double
    getSingleInstanceAssignment()
    If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group.
    double
    getUtilizationTarget()
    The target value of the metric that autoscaler maintains.
    String
    getUtilizationTargetType()
    Defines how target utilization value is expressed for a Stackdriver Monitoring metric.
    com.google.protobuf.ByteString
    getUtilizationTargetTypeBytes()
    Defines how target utilization value is expressed for a Stackdriver Monitoring metric.
    boolean
    hasFilter()
    A filter string, compatible with a Stackdriver Monitoringfilter string forTimeSeries.list API call.
    boolean
    hasMetric()
    The identifier (type) of the Stackdriver Monitoring metric.
    boolean
    hasSingleInstanceAssignment()
    If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group.
    boolean
    hasUtilizationTarget()
    The target value of the metric that autoscaler maintains.
    boolean
    hasUtilizationTargetType()
    Defines how target utilization value is expressed for a Stackdriver Monitoring metric.

    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 Details

    • hasFilter

      boolean hasFilter()
       A filter string, compatible with a Stackdriver Monitoringfilter string forTimeSeries.list API call. This filter is
 used to select a specific TimeSeries for the purpose of autoscaling and
 to determine whether the metric is exporting per-instance or
 per-group data.

 For the filter to be valid for autoscaling purposes, the following rules
 apply:


 - You can only use the AND operator for joining
 selectors.
 - You can only use direct equality comparison operator
 (=) without any functions for each selector.
 - You can specify the metric in both the filter string and in the
 metric field. However, if specified in both places, the metric must
 be identical.
 - The monitored resource type
 determines what kind of values are expected for the metric. If it is
 a gce_instance, the autoscaler expects the metric to
 include a separate TimeSeries for each instance in a group. In such a
 case, you cannot filter on resource labels.


 If the resource type is any other value, the autoscaler expects
 this metric to contain values that apply to the entire autoscaled
 instance group and resource label filtering can be performed to
 point autoscaler at the correct TimeSeries to scale upon. This is
 called a *per-group metric* for the purpose of autoscaling.

 If not specified, the type defaults to
 gce_instance.



 Try to provide a filter that is selective enough to pick just one
 TimeSeries for the autoscaled group or for each of the instances (if you
 are using gce_instance resource type). If multiple
 TimeSeries are returned upon the query execution, the autoscaler will sum
 their respective values to obtain its scaling value.
      optional string filter = 336120696;
      Returns:
      Whether the filter field is set.

    • getFilter

      String getFilter()
       A filter string, compatible with a Stackdriver Monitoringfilter string forTimeSeries.list API call. This filter is
 used to select a specific TimeSeries for the purpose of autoscaling and
 to determine whether the metric is exporting per-instance or
 per-group data.

 For the filter to be valid for autoscaling purposes, the following rules
 apply:


 - You can only use the AND operator for joining
 selectors.
 - You can only use direct equality comparison operator
 (=) without any functions for each selector.
 - You can specify the metric in both the filter string and in the
 metric field. However, if specified in both places, the metric must
 be identical.
 - The monitored resource type
 determines what kind of values are expected for the metric. If it is
 a gce_instance, the autoscaler expects the metric to
 include a separate TimeSeries for each instance in a group. In such a
 case, you cannot filter on resource labels.


 If the resource type is any other value, the autoscaler expects
 this metric to contain values that apply to the entire autoscaled
 instance group and resource label filtering can be performed to
 point autoscaler at the correct TimeSeries to scale upon. This is
 called a *per-group metric* for the purpose of autoscaling.

 If not specified, the type defaults to
 gce_instance.



 Try to provide a filter that is selective enough to pick just one
 TimeSeries for the autoscaled group or for each of the instances (if you
 are using gce_instance resource type). If multiple
 TimeSeries are returned upon the query execution, the autoscaler will sum
 their respective values to obtain its scaling value.
      optional string filter = 336120696;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       A filter string, compatible with a Stackdriver Monitoringfilter string forTimeSeries.list API call. This filter is
 used to select a specific TimeSeries for the purpose of autoscaling and
 to determine whether the metric is exporting per-instance or
 per-group data.

 For the filter to be valid for autoscaling purposes, the following rules
 apply:


 - You can only use the AND operator for joining
 selectors.
 - You can only use direct equality comparison operator
 (=) without any functions for each selector.
 - You can specify the metric in both the filter string and in the
 metric field. However, if specified in both places, the metric must
 be identical.
 - The monitored resource type
 determines what kind of values are expected for the metric. If it is
 a gce_instance, the autoscaler expects the metric to
 include a separate TimeSeries for each instance in a group. In such a
 case, you cannot filter on resource labels.


 If the resource type is any other value, the autoscaler expects
 this metric to contain values that apply to the entire autoscaled
 instance group and resource label filtering can be performed to
 point autoscaler at the correct TimeSeries to scale upon. This is
 called a *per-group metric* for the purpose of autoscaling.

 If not specified, the type defaults to
 gce_instance.



 Try to provide a filter that is selective enough to pick just one
 TimeSeries for the autoscaled group or for each of the instances (if you
 are using gce_instance resource type). If multiple
 TimeSeries are returned upon the query execution, the autoscaler will sum
 their respective values to obtain its scaling value.
      optional string filter = 336120696;
      Returns:
      The bytes for filter.

    • hasMetric

      boolean hasMetric()
       The identifier (type) of the Stackdriver Monitoring metric. The metric
 cannot have negative values.

 The metric must have a value type of INT64 orDOUBLE.
      optional string metric = 533067184;
      Returns:
      Whether the metric field is set.

    • getMetric

      String getMetric()
       The identifier (type) of the Stackdriver Monitoring metric. The metric
 cannot have negative values.

 The metric must have a value type of INT64 orDOUBLE.
      optional string metric = 533067184;
      Returns:
      The metric.

    • getMetricBytes

      com.google.protobuf.ByteString getMetricBytes()
       The identifier (type) of the Stackdriver Monitoring metric. The metric
 cannot have negative values.

 The metric must have a value type of INT64 orDOUBLE.
      optional string metric = 533067184;
      Returns:
      The bytes for metric.

    • hasSingleInstanceAssignment

      boolean hasSingleInstanceAssignment()
       If scaling is based on a per-group metric value that represents the
 total amount of work to be done or resource usage, set this value to an
 amount assigned for a single instance of the scaled group. Autoscaler
 keeps the number of instances proportional to the value of this
 metric. The metric itself does not change value due to group
 resizing.

 A good metric to use with the target is for examplepubsub.googleapis.com/subscription/num_undelivered_messages
 or a custom metric exporting the total number of requests coming to
 your instances.

 A bad example would be a metric exporting an average or median latency,
 since this value can't include a chunk assignable to a single instance,
 it could be better used with utilization_target instead.
      optional double single_instance_assignment = 504768064;
      Returns:
      Whether the singleInstanceAssignment field is set.

    • getSingleInstanceAssignment

      double getSingleInstanceAssignment()
       If scaling is based on a per-group metric value that represents the
 total amount of work to be done or resource usage, set this value to an
 amount assigned for a single instance of the scaled group. Autoscaler
 keeps the number of instances proportional to the value of this
 metric. The metric itself does not change value due to group
 resizing.

 A good metric to use with the target is for examplepubsub.googleapis.com/subscription/num_undelivered_messages
 or a custom metric exporting the total number of requests coming to
 your instances.

 A bad example would be a metric exporting an average or median latency,
 since this value can't include a chunk assignable to a single instance,
 it could be better used with utilization_target instead.
      optional double single_instance_assignment = 504768064;
      Returns:
      The singleInstanceAssignment.

    • hasUtilizationTarget

      boolean hasUtilizationTarget()
       The target value of the metric that autoscaler maintains. This
 must be a positive value. A utilization metric scales number of
 virtual machines handling requests to increase or decrease
 proportionally to the metric.

 For example, a good metric to use as a utilization_target ishttps://www.googleapis.com/compute/v1/instance/network/received_bytes_count.
 The autoscaler works to keep this value constant for each of the
 instances.
      optional double utilization_target = 215905870;
      Returns:
      Whether the utilizationTarget field is set.

    • getUtilizationTarget

      double getUtilizationTarget()
       The target value of the metric that autoscaler maintains. This
 must be a positive value. A utilization metric scales number of
 virtual machines handling requests to increase or decrease
 proportionally to the metric.

 For example, a good metric to use as a utilization_target ishttps://www.googleapis.com/compute/v1/instance/network/received_bytes_count.
 The autoscaler works to keep this value constant for each of the
 instances.
      optional double utilization_target = 215905870;
      Returns:
      The utilizationTarget.

    • hasUtilizationTargetType

      boolean hasUtilizationTargetType()
       Defines how target utilization value is expressed for a Stackdriver
 Monitoring metric. Either GAUGE,DELTA_PER_SECOND, or DELTA_PER_MINUTE.
 Check the UtilizationTargetType enum for the list of possible values.
      optional string utilization_target_type = 340169355;
      Returns:
      Whether the utilizationTargetType field is set.

    • getUtilizationTargetType

      String getUtilizationTargetType()
       Defines how target utilization value is expressed for a Stackdriver
 Monitoring metric. Either GAUGE,DELTA_PER_SECOND, or DELTA_PER_MINUTE.
 Check the UtilizationTargetType enum for the list of possible values.
      optional string utilization_target_type = 340169355;
      Returns:
      The utilizationTargetType.

    • getUtilizationTargetTypeBytes

      com.google.protobuf.ByteString getUtilizationTargetTypeBytes()
       Defines how target utilization value is expressed for a Stackdriver
 Monitoring metric. Either GAUGE,DELTA_PER_SECOND, or DELTA_PER_MINUTE.
 Check the UtilizationTargetType enum for the list of possible values.
      optional string utilization_target_type = 340169355;
      Returns:
      The bytes for utilizationTargetType.