Class AutoscalingMetricSpec.Builder (3.84.0)

Version latest

• 3.84.0 (latest)
• 3.83.0
• 3.82.0
• 3.81.0
• 3.79.0
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 3.71.0
• 3.69.0
• 3.68.0
• 3.65.0
• 3.64.0
• 3.63.0
• 3.61.0
• 3.60.0
• 3.59.0
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AutoscalingMetricSpec.Builder

Implements

AutoscalingMetricSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

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

GeneratedMessage.Builder<BuilderType>.clear()

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

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.

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

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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()

Use #getMonitoredResourceLabelsMap() instead.

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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.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.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AutoscalingMetricSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AutoscalingMetricSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

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.

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.