target.apidocs.com.google.api.services.compute.model.AutoscalingPolicyCustomMetricUtilization.html Maven / Gradle / Ivy

Go to download







AutoscalingPolicyCustomMetricUtilization (Compute Engine API alpha-rev20200526-1.30.9)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class AutoscalingPolicyCustomMetricUtilization



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.AutoscalingPolicyCustomMetricUtilization













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class AutoscalingPolicyCustomMetricUtilization
extends GenericJson
Custom utilization metric policy.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


AutoscalingPolicyCustomMetricUtilization() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AutoscalingPolicyCustomMetricUtilization
clone() 


String
getFilter()
A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API
 call.



String
getMetric()
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 should maintain.



String
getUtilizationTargetType()
Defines how target utilization value is expressed for a Stackdriver Monitoring metric.



AutoscalingPolicyCustomMetricUtilization
set(String fieldName,
   Object value) 


AutoscalingPolicyCustomMetricUtilization
setFilter(String filter)
A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API
 call.



AutoscalingPolicyCustomMetricUtilization
setMetric(String metric)
The identifier (type) of the Stackdriver Monitoring metric.



AutoscalingPolicyCustomMetricUtilization
setSingleInstanceAssignment(Double singleInstanceAssignment)
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.



AutoscalingPolicyCustomMetricUtilization
setUtilizationTarget(Double utilizationTarget)
The target value of the metric that autoscaler should maintain.



AutoscalingPolicyCustomMetricUtilization
setUtilizationTargetType(String utilizationTargetType)
Defines how target utilization value is expressed for a Stackdriver Monitoring metric.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





AutoscalingPolicyCustomMetricUtilization
public AutoscalingPolicyCustomMetricUtilization()









Method Detail





getFilter
public String getFilter()
A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.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.

 You should 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.

Returns:
value or null for none








setFilter
public AutoscalingPolicyCustomMetricUtilization setFilter(String filter)
A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.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.

 You should 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.

Parameters:
filter - filter or null for none








getMetric
public 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 or DOUBLE.

Returns:
value or null for none








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

 The metric must have a value type of INT64 or DOUBLE.

Parameters:
metric - metric or null for none








getSingleInstanceAssignment
public 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 will keep the number of instances proportional to the value of this
 metric, the metric itself should not change value due to group resizing.

 A good metric to use with the target is for example
 pubsub.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.

Returns:
value or null for none








setSingleInstanceAssignment
public AutoscalingPolicyCustomMetricUtilization setSingleInstanceAssignment(Double singleInstanceAssignment)
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 will keep the number of instances proportional to the value of this
 metric, the metric itself should not change value due to group resizing.

 A good metric to use with the target is for example
 pubsub.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.

Parameters:
singleInstanceAssignment - singleInstanceAssignment or null for none








getUtilizationTarget
public Double getUtilizationTarget()
The target value of the metric that autoscaler should maintain. 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 is
 compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep
 this value constant for each of the instances.

Returns:
value or null for none








setUtilizationTarget
public AutoscalingPolicyCustomMetricUtilization setUtilizationTarget(Double utilizationTarget)
The target value of the metric that autoscaler should maintain. 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 is
 compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep
 this value constant for each of the instances.

Parameters:
utilizationTarget - utilizationTarget or null for none








getUtilizationTargetType
public String getUtilizationTargetType()
Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either
 GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Returns:
value or null for none








setUtilizationTargetType
public AutoscalingPolicyCustomMetricUtilization setUtilizationTargetType(String utilizationTargetType)
Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either
 GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

Parameters:
utilizationTargetType - utilizationTargetType or null for none








set
public AutoscalingPolicyCustomMetricUtilization set(String fieldName,
                                                    Object value)

Overrides:
set in class GenericJson








clone
public AutoscalingPolicyCustomMetricUtilization clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`AutoscalingPolicyCustomMetricUtilization`	`clone()`
`String`	`getFilter()` A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call.
`String`	`getMetric()` 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 should maintain.
`String`	`getUtilizationTargetType()` Defines how target utilization value is expressed for a Stackdriver Monitoring metric.
`AutoscalingPolicyCustomMetricUtilization`	`set(String fieldName, Object value)`
`AutoscalingPolicyCustomMetricUtilization`	`setFilter(String filter)` A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call.
`AutoscalingPolicyCustomMetricUtilization`	`setMetric(String metric)` The identifier (type) of the Stackdriver Monitoring metric.
`AutoscalingPolicyCustomMetricUtilization`	`setSingleInstanceAssignment(Double singleInstanceAssignment)` 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.
`AutoscalingPolicyCustomMetricUtilization`	`setUtilizationTarget(Double utilizationTarget)` The target value of the metric that autoscaler should maintain.
`AutoscalingPolicyCustomMetricUtilization`	`setUtilizationTargetType(String utilizationTargetType)` Defines how target utilization value is expressed for a Stackdriver Monitoring metric.