public final class AutoscalingPolicyCustomMetricUtilization extends GeneratedMessageV3 implements AutoscalingPolicyCustomMetricUtilizationOrBuilder
Custom utilization metric policy.
Protobuf type google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
METRIC_FIELD_NUMBER
public static final int METRIC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SINGLE_INSTANCE_ASSIGNMENT_FIELD_NUMBER
public static final int SINGLE_INSTANCE_ASSIGNMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UTILIZATION_TARGET_FIELD_NUMBER
public static final int UTILIZATION_TARGET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UTILIZATION_TARGET_TYPE_FIELD_NUMBER
public static final int UTILIZATION_TARGET_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static AutoscalingPolicyCustomMetricUtilization getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AutoscalingPolicyCustomMetricUtilization.Builder newBuilder()
newBuilder(AutoscalingPolicyCustomMetricUtilization prototype)
public static AutoscalingPolicyCustomMetricUtilization.Builder newBuilder(AutoscalingPolicyCustomMetricUtilization prototype)
public static AutoscalingPolicyCustomMetricUtilization parseDelimitedFrom(InputStream input)
public static AutoscalingPolicyCustomMetricUtilization parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(CodedInputStream input)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(InputStream input)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AutoscalingPolicyCustomMetricUtilization parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AutoscalingPolicyCustomMetricUtilization> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public AutoscalingPolicyCustomMetricUtilization getDefaultInstanceForType()
getFilter()
public 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 |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for filter.
|
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 orDOUBLE.
optional string metric = 533067184;
| Returns |
| Type |
Description |
String |
The metric.
|
getMetricBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for metric.
|
getParserForType()
public Parser<AutoscalingPolicyCustomMetricUtilization> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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
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 |
| Type |
Description |
double |
The singleInstanceAssignment.
|
getUtilizationTarget()
public 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 |
| Type |
Description |
double |
The utilizationTarget.
|
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.
Check the UtilizationTargetType enum for the list of possible values.
optional string utilization_target_type = 340169355;
| Returns |
| Type |
Description |
String |
The utilizationTargetType.
|
getUtilizationTargetTypeBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for utilizationTargetType.
|
hasFilter()
public 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 |
| Type |
Description |
boolean |
Whether the filter field is set.
|
hasMetric()
public 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 |
| Type |
Description |
boolean |
Whether the metric field is set.
|
hasSingleInstanceAssignment()
public 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 |
| Type |
Description |
boolean |
Whether the singleInstanceAssignment field is set.
|
hasUtilizationTarget()
public 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 |
| Type |
Description |
boolean |
Whether the utilizationTarget field is set.
|
hasUtilizationTargetType()
public 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 |
| Type |
Description |
boolean |
Whether the utilizationTargetType field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AutoscalingPolicyCustomMetricUtilization.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AutoscalingPolicyCustomMetricUtilization.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AutoscalingPolicyCustomMetricUtilization.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
