Class AutoscalingMetricSpec.Builder (3.24.0)

public static final class AutoscalingMetricSpec.Builder extends GeneratedMessageV3.Builder<AutoscalingMetricSpec.Builder> 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.aiplatform.v1.AutoscalingMetricSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AutoscalingMetricSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

build()

public AutoscalingMetricSpec build()
Returns
TypeDescription
AutoscalingMetricSpec

buildPartial()

public AutoscalingMetricSpec buildPartial()
Returns
TypeDescription
AutoscalingMetricSpec

clear()

public AutoscalingMetricSpec.Builder clear()
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AutoscalingMetricSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

clearMetricName()

public AutoscalingMetricSpec.Builder clearMetricName()

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
TypeDescription
AutoscalingMetricSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AutoscalingMetricSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

clearTarget()

public AutoscalingMetricSpec.Builder clearTarget()

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
TypeDescription
AutoscalingMetricSpec.Builder

This builder for chaining.

clone()

public AutoscalingMetricSpec.Builder clone()
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

getDefaultInstanceForType()

public AutoscalingMetricSpec getDefaultInstanceForType()
Returns
TypeDescription
AutoscalingMetricSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for metricName.

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
TypeDescription
int

The target.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AutoscalingMetricSpec other)

public AutoscalingMetricSpec.Builder mergeFrom(AutoscalingMetricSpec other)
Parameter
NameDescription
otherAutoscalingMetricSpec
Returns
TypeDescription
AutoscalingMetricSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AutoscalingMetricSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AutoscalingMetricSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AutoscalingMetricSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AutoscalingMetricSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

setMetricName(String value)

public AutoscalingMetricSpec.Builder setMetricName(String value)

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

Parameter
NameDescription
valueString

The metricName to set.

Returns
TypeDescription
AutoscalingMetricSpec.Builder

This builder for chaining.

setMetricNameBytes(ByteString value)

public AutoscalingMetricSpec.Builder setMetricNameBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for metricName to set.

Returns
TypeDescription
AutoscalingMetricSpec.Builder

This builder for chaining.

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

public AutoscalingMetricSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides

setTarget(int value)

public AutoscalingMetricSpec.Builder setTarget(int value)

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;

Parameter
NameDescription
valueint

The target to set.

Returns
TypeDescription
AutoscalingMetricSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AutoscalingMetricSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AutoscalingMetricSpec.Builder
Overrides