Class BackendCustomMetric.Builder (1.70.0)

public static final class BackendCustomMetric.Builder extends GeneratedMessageV3.Builder<BackendCustomMetric.Builder> implements BackendCustomMetricOrBuilder

Custom Metrics are used for CUSTOM_METRICS balancing_mode.

Protobuf type google.cloud.compute.v1.BackendCustomMetric

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BackendCustomMetric build()
Returns
Type Description
BackendCustomMetric

buildPartial()

public BackendCustomMetric buildPartial()
Returns
Type Description
BackendCustomMetric

clear()

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

clearDryRun()

public BackendCustomMetric.Builder clearDryRun()

If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.

optional bool dry_run = 323854839;

Returns
Type Description
BackendCustomMetric.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMaxUtilization()

public BackendCustomMetric.Builder clearMaxUtilization()

Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].

optional float max_utilization = 148192199;

Returns
Type Description
BackendCustomMetric.Builder

This builder for chaining.

clearName()

public BackendCustomMetric.Builder clearName()

Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

optional string name = 3373707;

Returns
Type Description
BackendCustomMetric.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public BackendCustomMetric getDefaultInstanceForType()
Returns
Type Description
BackendCustomMetric

getDescriptorForType()

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

getDryRun()

public boolean getDryRun()

If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.

optional bool dry_run = 323854839;

Returns
Type Description
boolean

The dryRun.

getMaxUtilization()

public float getMaxUtilization()

Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].

optional float max_utilization = 148192199;

Returns
Type Description
float

The maxUtilization.

getName()

public String getName()

Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

hasDryRun()

public boolean hasDryRun()

If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.

optional bool dry_run = 323854839;

Returns
Type Description
boolean

Whether the dryRun field is set.

hasMaxUtilization()

public boolean hasMaxUtilization()

Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].

optional float max_utilization = 148192199;

Returns
Type Description
boolean

Whether the maxUtilization field is set.

hasName()

public boolean hasName()

Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BackendCustomMetric other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDryRun(boolean value)

public BackendCustomMetric.Builder setDryRun(boolean value)

If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.

optional bool dry_run = 323854839;

Parameter
Name Description
value boolean

The dryRun to set.

Returns
Type Description
BackendCustomMetric.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setMaxUtilization(float value)

public BackendCustomMetric.Builder setMaxUtilization(float value)

Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].

optional float max_utilization = 148192199;

Parameter
Name Description
value float

The maxUtilization to set.

Returns
Type Description
BackendCustomMetric.Builder

This builder for chaining.

setName(String value)

public BackendCustomMetric.Builder setName(String value)

Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

optional string name = 3373707;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
BackendCustomMetric.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BackendCustomMetric.Builder setNameBytes(ByteString value)

Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

optional string name = 3373707;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
BackendCustomMetric.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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