Class AutoscalingMetricSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AutoscalingMetricSpec.Builder>
com.google.cloud.aiplatform.v1beta1.AutoscalingMetricSpec.Builder
All Implemented Interfaces:
AutoscalingMetricSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AutoscalingMetricSpec

public static final class AutoscalingMetricSpec.Builder extends com.google.protobuf.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
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<AutoscalingMetricSpec.Builder>
    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<AutoscalingMetricSpec.Builder>
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<AutoscalingMetricSpec.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<AutoscalingMetricSpec.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<AutoscalingMetricSpec.Builder>
    • getDefaultInstanceForType

      public AutoscalingMetricSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public AutoscalingMetricSpec build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public AutoscalingMetricSpec buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public AutoscalingMetricSpec.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AutoscalingMetricSpec.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<AutoscalingMetricSpec.Builder>
    • mergeFrom

      public AutoscalingMetricSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AutoscalingMetricSpec.Builder>
      Throws:
      IOException
    • 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];
      Specified by:
      getMetricName in interface AutoscalingMetricSpecOrBuilder
      Returns:
      The metricName.
    • getMetricNameBytes

      public com.google.protobuf.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];
      Specified by:
      getMetricNameBytes in interface AutoscalingMetricSpecOrBuilder
      Returns:
      The bytes for metricName.
    • setMetricName

      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];
      Parameters:
      value - The metricName to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • setMetricNameBytes

      public AutoscalingMetricSpec.Builder setMetricNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for metricName to set.
      Returns:
      This builder for chaining.
    • 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;
      Specified by:
      getTarget in interface AutoscalingMetricSpecOrBuilder
      Returns:
      The target.
    • setTarget

      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;
      Parameters:
      value - The target to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • getMonitoredResourceLabelsCount

      public int getMonitoredResourceLabelsCount()
      Description copied from interface: AutoscalingMetricSpecOrBuilder
       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];
      Specified by:
      getMonitoredResourceLabelsCount in interface AutoscalingMetricSpecOrBuilder
    • containsMonitoredResourceLabels

      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];
      Specified by:
      containsMonitoredResourceLabels in interface AutoscalingMetricSpecOrBuilder
    • getMonitoredResourceLabels

      @Deprecated public Map<String,String> getMonitoredResourceLabels()
      Deprecated.
      Specified by:
      getMonitoredResourceLabels in interface AutoscalingMetricSpecOrBuilder
    • 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];
      Specified by:
      getMonitoredResourceLabelsMap in interface AutoscalingMetricSpecOrBuilder
    • getMonitoredResourceLabelsOrDefault

      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];
      Specified by:
      getMonitoredResourceLabelsOrDefault in interface AutoscalingMetricSpecOrBuilder
    • getMonitoredResourceLabelsOrThrow

      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];
      Specified by:
      getMonitoredResourceLabelsOrThrow in interface AutoscalingMetricSpecOrBuilder
    • clearMonitoredResourceLabels

      public AutoscalingMetricSpec.Builder clearMonitoredResourceLabels()
    • removeMonitoredResourceLabels

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

      @Deprecated public Map<String,String> getMutableMonitoredResourceLabels()
      Deprecated.
      Use alternate mutation accessors instead.
    • putMonitoredResourceLabels

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

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