Class AutoscalingPolicyCustomMetricUtilization.Builder (1.59.0) 

public static final class AutoscalingPolicyCustomMetricUtilization.Builder extends GeneratedMessageV3.Builder<AutoscalingPolicyCustomMetricUtilization.Builder> implements AutoscalingPolicyCustomMetricUtilizationOrBuilder

Custom utilization metric policy.

Protobuf type google.cloud.compute.v1.AutoscalingPolicyCustomMetricUtilization

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AutoscalingPolicyCustomMetricUtilization.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AutoscalingPolicyCustomMetricUtilization.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

build()

public AutoscalingPolicyCustomMetricUtilization build()
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization

buildPartial()

public AutoscalingPolicyCustomMetricUtilization buildPartial()
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization

clear()

public AutoscalingPolicyCustomMetricUtilization.Builder clear()
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AutoscalingPolicyCustomMetricUtilization.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

clearFilter()

public AutoscalingPolicyCustomMetricUtilization.Builder clearFilter()

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. 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
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

clearMetric()

public AutoscalingPolicyCustomMetricUtilization.Builder clearMetric()

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.

optional string metric = 533067184;

Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AutoscalingPolicyCustomMetricUtilization.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

clearSingleInstanceAssignment()

public AutoscalingPolicyCustomMetricUtilization.Builder clearSingleInstanceAssignment()

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

optional double single_instance_assignment = 504768064;

Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

clearUtilizationTarget()

public AutoscalingPolicyCustomMetricUtilization.Builder clearUtilizationTarget()

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 is https://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
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

clearUtilizationTargetType()

public AutoscalingPolicyCustomMetricUtilization.Builder clearUtilizationTargetType()

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
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

clone()

public AutoscalingPolicyCustomMetricUtilization.Builder clone()
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

getDefaultInstanceForType()

public AutoscalingPolicyCustomMetricUtilization getDefaultInstanceForType()
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

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

optional string metric = 533067184;

Returns
Type Description
ByteString

The bytes for metric.

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

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 is https://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 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. 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 or DOUBLE.

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

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 is https://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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AutoscalingPolicyCustomMetricUtilization other)

public AutoscalingPolicyCustomMetricUtilization.Builder mergeFrom(AutoscalingPolicyCustomMetricUtilization other)
Parameter
Name Description
other AutoscalingPolicyCustomMetricUtilization
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AutoscalingPolicyCustomMetricUtilization.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AutoscalingPolicyCustomMetricUtilization.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AutoscalingPolicyCustomMetricUtilization.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AutoscalingPolicyCustomMetricUtilization.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

setFilter(String value)

public AutoscalingPolicyCustomMetricUtilization.Builder setFilter(String value)

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. 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;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public AutoscalingPolicyCustomMetricUtilization.Builder setFilterBytes(ByteString value)

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. 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;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

setMetric(String value)

public AutoscalingPolicyCustomMetricUtilization.Builder setMetric(String value)

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.

optional string metric = 533067184;

Parameter
Name Description
value String

The metric to set.
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

setMetricBytes(ByteString value)

public AutoscalingPolicyCustomMetricUtilization.Builder setMetricBytes(ByteString value)

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.

optional string metric = 533067184;

Parameter
Name Description
value ByteString

The bytes for metric to set.
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AutoscalingPolicyCustomMetricUtilization.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

setSingleInstanceAssignment(double value)

public AutoscalingPolicyCustomMetricUtilization.Builder setSingleInstanceAssignment(double value)

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

optional double single_instance_assignment = 504768064;

Parameter
Name Description
value double

The singleInstanceAssignment to set.
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AutoscalingPolicyCustomMetricUtilization.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder
Overrides

setUtilizationTarget(double value)

public AutoscalingPolicyCustomMetricUtilization.Builder setUtilizationTarget(double value)

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 is https://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;

Parameter
Name Description
value double

The utilizationTarget to set.
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

setUtilizationTargetType(String value)

public AutoscalingPolicyCustomMetricUtilization.Builder setUtilizationTargetType(String value)

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;

Parameter
Name Description
value String

The utilizationTargetType to set.
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.

setUtilizationTargetTypeBytes(ByteString value)

public AutoscalingPolicyCustomMetricUtilization.Builder setUtilizationTargetTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for utilizationTargetType to set.
Returns
Type Description
AutoscalingPolicyCustomMetricUtilization.Builder

This builder for chaining.