Class AutoscalingMetricSpec (1.2.0)

public final class AutoscalingMetricSpec extends GeneratedMessageV3 implements AutoscalingMetricSpecOrBuilder

The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.

Protobuf type google.cloud.vertexai.v1.AutoscalingMetricSpec

Static Fields

METRIC_NAME_FIELD_NUMBER

public static final int METRIC_NAME_FIELD_NUMBER
Field Value
Type Description
int

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AutoscalingMetricSpec getDefaultInstance()
Returns
Type Description
AutoscalingMetricSpec

getDescriptor()

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

newBuilder()

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

newBuilder(AutoscalingMetricSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public AutoscalingMetricSpec getDefaultInstanceForType()
Returns
Type Description
AutoscalingMetricSpec

getMetricName()

public String getMetricName()

Required. The resource metric name. Supported metrics:

  • For Online Prediction:
  • aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle
  • aiplatform.googleapis.com/prediction/online/cpu/utilization

string metric_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The metricName.

getMetricNameBytes()

public ByteString getMetricNameBytes()

Required. The resource metric name. Supported metrics:

  • For Online Prediction:
  • aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle
  • aiplatform.googleapis.com/prediction/online/cpu/utilization

string metric_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for metricName.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTarget()

public int getTarget()

The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided.

int32 target = 2;

Returns
Type Description
int

The target.

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 AutoscalingMetricSpec.Builder newBuilderForType()
Returns
Type Description
AutoscalingMetricSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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