Package com.google.cloud.aiplatform.v1

Enum Metric.AggregationMetric

java.lang.Object
java.lang.Enum<Metric.AggregationMetric>
com.google.cloud.aiplatform.v1.Metric.AggregationMetric
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Metric.AggregationMetric>
Enclosing class:
Metric
public static enum Metric.AggregationMetric extends Enum<Metric.AggregationMetric> implements com.google.protobuf.ProtocolMessageEnum
 The per-metric statistics on evaluation results supported by
 `EvaluationService.EvaluateDataset`.
Protobuf enum google.cloud.aiplatform.v1.Metric.AggregationMetric

  • Enum Constant Details

    • AGGREGATION_METRIC_UNSPECIFIED

      public static final Metric.AggregationMetric AGGREGATION_METRIC_UNSPECIFIED
       Unspecified aggregation metric.
      AGGREGATION_METRIC_UNSPECIFIED = 0;

    • AVERAGE

      public static final Metric.AggregationMetric AVERAGE
       Average aggregation metric. Not supported for Pairwise metric.
      AVERAGE = 1;

    • MODE

      public static final Metric.AggregationMetric MODE
       Mode aggregation metric.
      MODE = 2;

    • STANDARD_DEVIATION

      public static final Metric.AggregationMetric STANDARD_DEVIATION
       Standard deviation aggregation metric. Not supported for pairwise metric.
      STANDARD_DEVIATION = 3;

    • VARIANCE

      public static final Metric.AggregationMetric VARIANCE
       Variance aggregation metric. Not supported for pairwise metric.
      VARIANCE = 4;

    • MINIMUM

      public static final Metric.AggregationMetric MINIMUM
       Minimum aggregation metric. Not supported for pairwise metric.
      MINIMUM = 5;

    • MAXIMUM

      public static final Metric.AggregationMetric MAXIMUM
       Maximum aggregation metric. Not supported for pairwise metric.
      MAXIMUM = 6;

    • MEDIAN

      public static final Metric.AggregationMetric MEDIAN
       Median aggregation metric. Not supported for pairwise metric.
      MEDIAN = 7;

    • PERCENTILE_P90

      public static final Metric.AggregationMetric PERCENTILE_P90
       90th percentile aggregation metric. Not supported for pairwise metric.
      PERCENTILE_P90 = 8;

    • PERCENTILE_P95

      public static final Metric.AggregationMetric PERCENTILE_P95
       95th percentile aggregation metric. Not supported for pairwise metric.
      PERCENTILE_P95 = 9;

    • PERCENTILE_P99

      public static final Metric.AggregationMetric PERCENTILE_P99
       99th percentile aggregation metric. Not supported for pairwise metric.
      PERCENTILE_P99 = 10;

    • UNRECOGNIZED

      public static final Metric.AggregationMetric UNRECOGNIZED

  • Field Details

    • AGGREGATION_METRIC_UNSPECIFIED_VALUE

      public static final int AGGREGATION_METRIC_UNSPECIFIED_VALUE
       Unspecified aggregation metric.
      AGGREGATION_METRIC_UNSPECIFIED = 0;
      See Also:

    • AVERAGE_VALUE

      public static final int AVERAGE_VALUE
       Average aggregation metric. Not supported for Pairwise metric.
      AVERAGE = 1;
      See Also:

    • MODE_VALUE

      public static final int MODE_VALUE
       Mode aggregation metric.
      MODE = 2;
      See Also:

    • STANDARD_DEVIATION_VALUE

      public static final int STANDARD_DEVIATION_VALUE
       Standard deviation aggregation metric. Not supported for pairwise metric.
      STANDARD_DEVIATION = 3;
      See Also:

    • VARIANCE_VALUE

      public static final int VARIANCE_VALUE
       Variance aggregation metric. Not supported for pairwise metric.
      VARIANCE = 4;
      See Also:

    • MINIMUM_VALUE

      public static final int MINIMUM_VALUE
       Minimum aggregation metric. Not supported for pairwise metric.
      MINIMUM = 5;
      See Also:

    • MAXIMUM_VALUE

      public static final int MAXIMUM_VALUE
       Maximum aggregation metric. Not supported for pairwise metric.
      MAXIMUM = 6;
      See Also:

    • MEDIAN_VALUE

      public static final int MEDIAN_VALUE
       Median aggregation metric. Not supported for pairwise metric.
      MEDIAN = 7;
      See Also:

    • PERCENTILE_P90_VALUE

      public static final int PERCENTILE_P90_VALUE
       90th percentile aggregation metric. Not supported for pairwise metric.
      PERCENTILE_P90 = 8;
      See Also:

    • PERCENTILE_P95_VALUE

      public static final int PERCENTILE_P95_VALUE
       95th percentile aggregation metric. Not supported for pairwise metric.
      PERCENTILE_P95 = 9;
      See Also:

    • PERCENTILE_P99_VALUE

      public static final int PERCENTILE_P99_VALUE
       99th percentile aggregation metric. Not supported for pairwise metric.
      PERCENTILE_P99 = 10;
      See Also:

  • Method Details

    • values

      public static Metric.AggregationMetric[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Metric.AggregationMetric valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static Metric.AggregationMetric valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static Metric.AggregationMetric forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<Metric.AggregationMetric> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static Metric.AggregationMetric valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null