Class AutoscalingMetricSpec.Builder (3.73.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.v1beta1.AutoscalingMetricSpec

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public AutoscalingMetricSpec build()
Returns
Type Description
AutoscalingMetricSpec

buildPartial()

public AutoscalingMetricSpec buildPartial()
Returns
Type Description
AutoscalingMetricSpec

clear()

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

clearField(Descriptors.FieldDescriptor field)

public AutoscalingMetricSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
  • aiplatform.googleapis.com/prediction/online/request_count

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

Returns
Type Description
AutoscalingMetricSpec.Builder

This builder for chaining.

clearMonitoredResourceLabels()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public AutoscalingMetricSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
AutoscalingMetricSpec.Builder

This builder for chaining.

clone()

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

containsMonitoredResourceLabels(String key)

public boolean containsMonitoredResourceLabels(String key)

Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info

map<string, string> monitored_resource_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public AutoscalingMetricSpec getDefaultInstanceForType()
Returns
Type Description
AutoscalingMetricSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
  • aiplatform.googleapis.com/prediction/online/request_count

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
  • aiplatform.googleapis.com/prediction/online/request_count

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

Returns
Type Description
ByteString

The bytes for metricName.

getMonitoredResourceLabels() (deprecated)

public Map<String,String> getMonitoredResourceLabels()
Returns
Type Description
Map<String,String>

getMonitoredResourceLabelsCount()

public int getMonitoredResourceLabelsCount()

Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info

map<string, string> monitored_resource_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getMonitoredResourceLabelsMap()

public Map<String,String> getMonitoredResourceLabelsMap()

Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info

map<string, string> monitored_resource_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getMonitoredResourceLabelsOrDefault(String key, String defaultValue)

public String getMonitoredResourceLabelsOrDefault(String key, String defaultValue)

Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info

map<string, string> monitored_resource_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMonitoredResourceLabelsOrThrow(String key)

public String getMonitoredResourceLabelsOrThrow(String key)

Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info

map<string, string> monitored_resource_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableMonitoredResourceLabels() (deprecated)

public Map<String,String> getMutableMonitoredResourceLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AutoscalingMetricSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllMonitoredResourceLabels(Map<String,String> values)

public AutoscalingMetricSpec.Builder putAllMonitoredResourceLabels(Map<String,String> values)

Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info

map<string, string> monitored_resource_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
AutoscalingMetricSpec.Builder

putMonitoredResourceLabels(String key, String value)

public AutoscalingMetricSpec.Builder putMonitoredResourceLabels(String key, String value)

Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info

map<string, string> monitored_resource_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
AutoscalingMetricSpec.Builder

removeMonitoredResourceLabels(String key)

public AutoscalingMetricSpec.Builder removeMonitoredResourceLabels(String key)

Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info

map<string, string> monitored_resource_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
AutoscalingMetricSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AutoscalingMetricSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
  • aiplatform.googleapis.com/prediction/online/request_count

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

Parameter
Name Description
value String

The metricName to set.

Returns
Type Description
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
  • aiplatform.googleapis.com/prediction/online/request_count

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

Parameter
Name Description
value ByteString

The bytes for metricName to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value int

The target to set.

Returns
Type Description
AutoscalingMetricSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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