Class BackendCustomMetric (1.70.0)

public final class BackendCustomMetric extends GeneratedMessageV3 implements BackendCustomMetricOrBuilder

Custom Metrics are used for CUSTOM_METRICS balancing_mode.

Protobuf type google.cloud.compute.v1.BackendCustomMetric

Static Fields

DRY_RUN_FIELD_NUMBER

public static final int DRY_RUN_FIELD_NUMBER
Field Value
Type Description
int

MAX_UTILIZATION_FIELD_NUMBER

public static final int MAX_UTILIZATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackendCustomMetric getDefaultInstance()
Returns
Type Description
BackendCustomMetric

getDescriptor()

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

newBuilder()

public static BackendCustomMetric.Builder newBuilder()
Returns
Type Description
BackendCustomMetric.Builder

newBuilder(BackendCustomMetric prototype)

public static BackendCustomMetric.Builder newBuilder(BackendCustomMetric prototype)
Parameter
Name Description
prototype BackendCustomMetric
Returns
Type Description
BackendCustomMetric.Builder

parseDelimitedFrom(InputStream input)

public static BackendCustomMetric parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendCustomMetric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BackendCustomMetric parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackendCustomMetric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackendCustomMetric parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackendCustomMetric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackendCustomMetric parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendCustomMetric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BackendCustomMetric parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendCustomMetric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BackendCustomMetric parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackendCustomMetric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendCustomMetric
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BackendCustomMetric> parser()
Returns
Type Description
Parser<BackendCustomMetric>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BackendCustomMetric getDefaultInstanceForType()
Returns
Type Description
BackendCustomMetric

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.

getParserForType()

public Parser<BackendCustomMetric> getParserForType()
Returns
Type Description
Parser<BackendCustomMetric>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BackendCustomMetric.Builder newBuilderForType()
Returns
Type Description
BackendCustomMetric.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackendCustomMetric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BackendCustomMetric.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BackendCustomMetric.Builder toBuilder()
Returns
Type Description
BackendCustomMetric.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException